Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

resource: add tidb-pdf-generation-tutorial.md #16134

Merged
merged 10 commits into from
Jan 26, 2024

Conversation

shawn0915
Copy link
Contributor

First-time contributors' checklist

What is changed, added or deleted? (Required)

translation

Which TiDB version(s) do your changes apply to? (Required)

Tips for choosing the affected version(s):

By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.

For details, see tips for choosing the affected versions.

  • master (the latest development version)
  • v7.6 (TiDB 7.6 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.4 (TiDB 7.4 versions)
  • v7.3 (TiDB 7.3 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.5 versions)
  • v6.1 (TiDB 6.1 versions)
  • v5.4 (TiDB 5.4 versions)
  • v5.3 (TiDB 5.3 versions)
  • v5.2 (TiDB 5.2 versions)
  • v5.1 (TiDB 5.1 versions)
  • v5.0 (TiDB 5.0 versions)

What is the related PR or file link(s)?

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

@ti-chi-bot ti-chi-bot bot added contribution This PR is from a community contributor. missing-translation-status This PR does not have translation status info. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jan 12, 2024
@shawn0915
Copy link
Contributor Author

/translation from-docs-cn

@ti-chi-bot ti-chi-bot bot added translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn. and removed missing-translation-status This PR does not have translation status info. labels Jan 12, 2024
@qiancai qiancai added the 2024-tidb-docs-dash This issue or PR is included in the 2024 TiDB Docs Dash event. label Jan 12, 2024
@qiancai qiancai self-requested a review January 12, 2024 08:07
@qiancai qiancai self-assigned this Jan 12, 2024
4. Generate document PDF:

```bash
bash scripts/generate_pdf.sh
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be nice to have a Makefile to do the generation of doc.md and PDF.

default: output.pdf

doc.md:
	./scripts/merge_by_toc.py

output.pdf: doc.md
	./scripts/generate_pdf.sh

Then make output.pdf would run merge_by_toc.py if there is no doc.md.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, it can save one step 👍

@ti-chi-bot ti-chi-bot bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Jan 15, 2024
@dveeden
Copy link
Contributor

dveeden commented Jan 15, 2024

Maybe we should also mention generate_cloud_pdf.sh?

4. Generate document PDF:

```bash
bash scripts/generate_pdf.sh
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, it can save one step 👍

Copy link

ti-chi-bot bot commented Jan 22, 2024

@dveeden: Your lgtm message is repeated, so it is ignored.

In response to this:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@ti-chi-bot ti-chi-bot bot added lgtm and removed needs-1-more-lgtm Indicates a PR needs 1 more LGTM. labels Jan 23, 2024
Copy link

ti-chi-bot bot commented Jan 23, 2024

[LGTM Timeline notifier]

Timeline:

  • 2024-01-15 07:44:17.926945832 +0000 UTC m=+169099.491243522: ☑️ agreed by dveeden.
  • 2024-01-23 09:04:40.689832517 +0000 UTC m=+865122.254130223: ☑️ agreed by qiancai.

@qiancai qiancai requested a review from lilin90 January 23, 2024 09:04
fix this:

```
[2024-01-23T09:09:05.602Z] resources/tidb-pdf-generation-tutorial.md: 85: MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]

[2024-01-23T09:09:05.602Z] resources/tidb-pdf-generation-tutorial.md: 92: MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]
```
@rpaik rpaik added the tidb-docs-dash-bonus Indicates that the issue or PR with bonus points label Jan 25, 2024
Copy link
Member

@lilin90 lilin90 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

fix this error.
```
[2024-01-25T10:17:03.126Z] resources/tidb-pdf-generation-tutorial.md: 10: MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]

[2024-01-25T10:17:03.126Z] resources/tidb-pdf-generation-tutorial.md: 15: MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]
```
@qiancai
Copy link
Collaborator

qiancai commented Jan 26, 2024

/approve

Copy link

ti-chi-bot bot commented Jan 26, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: qiancai

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@ti-chi-bot ti-chi-bot bot added the approved label Jan 26, 2024
@ti-chi-bot ti-chi-bot bot merged commit e87c9d0 into pingcap:master Jan 26, 2024
9 checks passed
@shawn0915 shawn0915 deleted the br-shawnyan-trans-15946 branch January 26, 2024 09:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2024-tidb-docs-dash This issue or PR is included in the 2024 TiDB Docs Dash event. approved contribution This PR is from a community contributor. lgtm size/L Denotes a PR that changes 100-499 lines, ignoring generated files. tidb-docs-dash-bonus Indicates that the issue or PR with bonus points translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn.
Development

Successfully merging this pull request may close these issues.

5 participants